<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>content_parse_docstrings | My Python Project</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">My Python Project</a>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          content_parse_docstrings <span class="m-thin">module</span>
        </h1>
        <p>This module has a <em>serious</em> docstring. And a <a class="m-doc" href="content_parse_docstrings.Class.html">Class</a>.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#classes">Classes</a></li>
                <li><a href="#enums">Enums</a></li>
                <li><a href="#functions">Functions</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>And module <strong>details</strong> as well.</p>
        <section id="classes">
          <h2><a href="#classes">Classes</a></h2>
          <dl class="m-doc">
            <dt>class <a href="content_parse_docstrings.Class.html" class="m-doc">Class</a></dt>
            <dd>This class has a <em>serious</em> docstring.
With a multi-line summary. Relative reference to <a class="m-doc" href="content_parse_docstrings.Class.html#a_property">a_property</a> works
even from a summary.</dd>
          </dl>
        </section>
        <section id="enums">
          <h2><a href="#enums">Enums</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">class <a href="#Enum" class="m-doc">Enum</a>(enum.Enum): </span><span class="m-doc-wrap"><a href="#Enum-VALUE" class="m-doc">VALUE</a> = 3
              <a href="#Enum-ANOTHER" class="m-doc">ANOTHER</a> = 4</span>
            </dt>
            <dd>This enum has a <em>serious</em> docstring. <a class="m-doc" href="content_parse_docstrings.html#Enum-VALUE">VALUE</a> works from a summary.</dd>
          </dl>
        </section>
        <section id="functions">
          <h2><a href="#functions">Functions</a></h2>
          <dl class="m-doc">
            <dt id="empty_docstring">
              <span class="m-doc-wrap-bumper">def <a href="#empty_docstring" class="m-doc-self">empty_docstring</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd></dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#function" class="m-doc">function</a>(</span><span class="m-doc-wrap">a: str,
              b: int) -&gt; float</span>
            </dt>
            <dd>This <a class="m-doc" href="content_parse_docstrings.html#function">function()</a> has a <em>serious</em> docstring.</dd>
            <dt id="summary_only">
              <span class="m-doc-wrap-bumper">def <a href="#summary_only" class="m-doc-self">summary_only</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>This is just a summary.</dd>
            <dt id="this_function_has_bad_docs">
              <span class="m-doc-wrap-bumper">def <a href="#this_function_has_bad_docs" class="m-doc-self">this_function_has_bad_docs</a>(</span><span class="m-doc-wrap">a, b) -&gt; str</span>
            </dt>
            <dd></dd>
          </dl>
        </section>
        <section>
          <h2>Enum documentation</h2>
          <section class="m-doc-details" id="Enum"><div>
            <h3>
              class content_parse_docstrings.<wbr /><a href="#Enum" class="m-doc-self">Enum</a>(enum.Enum)
            </h3>
            <p>This enum has a <em>serious</em> docstring. <a class="m-doc" href="content_parse_docstrings.html#Enum-VALUE">VALUE</a> works from a summary.</p>
            <table class="m-table m-fullwidth m-flat m-doc">
              <thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
              <tbody>
                <tr>
                  <td><a href="#Enum-VALUE" id="Enum-VALUE" class="m-doc-self">VALUE</a></td>
                  <td>
<p>Enum value docstrings are <em>processed</em> as well.</p>
<p>The <a class="m-doc" href="content_parse_docstrings.html#Enum-ANOTHER">ANOTHER</a> value is documented from within the <a class="m-doc" href="content_parse_docstrings.html#Enum">Enum</a> itself.</p>
                  </td>
                </tr>
                <tr>
                  <td><a href="#Enum-ANOTHER" id="Enum-ANOTHER" class="m-doc-self">ANOTHER</a></td>
                  <td>
<p>Values can be documented from a docstring, too.</p>
                  </td>
                </tr>
              </tbody>
            </table>
<p>And enum <strong>details</strong> as well.</p>
          </div></section>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="function"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content_parse_docstrings.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#function" class="m-doc-self">function</a>(</span><span class="m-doc-wrap">a: str,
              b: int) -&gt; float</span></span>
            </h3>
            <p>This <a class="m-doc" href="content_parse_docstrings.html#function">function()</a> has a <em>serious</em> docstring.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>And parameter docs, referring to <a class="m-doc" href="content_parse_docstrings.html#function">function()</a> as well.
On multiple lines.</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td><em>Wow.</em></td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>This too. In the <a class="m-doc" href="content_parse_docstrings.html#function">function()</a>.</td>
                </tr>
              </tfoot>
            </table>
<p>And details.
<strong>Amazing</strong>.</p>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
</body>
</html>
